1. Order
  2. Landed Cost

Landed Cost GET

URI

https://{DATACENTER}.brightpearlconnect.com/public-api/{ACCOUNT}
/order-service/landed-cost

Refer to our documentation on URI syntax for more information on how to construct URIs.

Description

Returns landed costs for the account. You can optionally filter by order, order row, supplier, reference, nominal code, reconciliation state, created date-time, and pagination parameters.

Date filters support either:

  • ISO 8601 date-time with timezone (for example 2025-06-01T10:15:30Z)
  • Date only in YYYY-MM-DD format (interpreted as 00:00:00 UTC)

Request query parameters

Parameter Type Description
orderId integer Filter by Order ID. Must be a positive integer.
orderRowId integer Filter by Order Row ID. Must be a positive integer.
supplierId string Comma-separated list of supplier IDs (for example 10,20,30).
reference string Exact match on landed cost reference. Maximum length is 32 characters.
nominalCode string Exact match on accounting nominal code.
isReconciled boolean Filter by reconciliation state. Accepted values are true and false.
dateFrom string Include records where createdOn is after this date-time.
dateTo string Include records where createdOn is before this date-time.
pageSize integer Number of results per page. Defaults to 50; valid range is 1-500.
pageNum integer Page number to return. Defaults to 1.

Response fields

Field Description
id The landed cost estimate ID.
orderId The Order ID for the landed cost row.
orderRowId The Order Row ID.
createdOn The creation timestamp in UTC ISO 8601 format.
unitAdjustmentOriginalCurrency Adjustment amount in the original currency.
unitAdjustmentBaseCurrency Adjustment amount in base currency.
reference Reference value entered when the landed cost was created.
nominalCode Accounting nominal code assigned to the landed cost.
currencyId The Currency ID of the original currency.
poRowQty The quantity on the corresponding purchase order row.
exchangeRate The exchange rate used for the landed cost.
payableSupplierId The supplier ID payable for this landed cost.
isReconciled Whether this landed cost has been reconciled.

Example 1

Retrieve landed cost estimates using multiple filters.

Request URI

/landed-cost?orderId=100182&supplierId=293,294&isReconciled=false&dateFrom=2025-06-01T00:00:00Z&dateTo=2025-06-30&pageSize=25&pageNum=1

Response

{
	"response": [
		{
			"id": 73,
			"orderId": 100182,
			"orderRowId": 58,
			"createdOn": "2025-06-05T09:30:00Z",
			"unitAdjustmentOriginalCurrency": 2,
			"unitAdjustmentBaseCurrency": 2,
			"reference": "3333",
			"nominalCode": "0010",
			"currencyId": 1,
			"poRowQty": 10,
			"exchangeRate": 1,
			"payableSupplierId": 293,
			"isReconciled": false
		},
		{
			"id": 78,
			"orderId": 100182,
			"orderRowId": 59,
			"createdOn": "2025-06-12T14:22:11Z",
			"unitAdjustmentOriginalCurrency": 1,
			"unitAdjustmentBaseCurrency": 1,
			"reference": "1",
			"nominalCode": "0010",
			"currencyId": 1,
			"poRowQty": 100,
			"exchangeRate": 1,
			"payableSupplierId": 293,
			"isReconciled": false
		}
	]
}

Example 2

Retrieve all landed costs for a single order row using date-only filters.

Request URI

/landed-cost?orderRowId=59&dateFrom=2025-06-01&dateTo=2025-06-30

Response

{
	"response": [
		{
			"id": 79,
			"orderId": 100182,
			"orderRowId": 59,
			"createdOn": "2025-06-18T08:45:00Z",
			"unitAdjustmentOriginalCurrency": 0.15,
			"unitAdjustmentBaseCurrency": 0.15,
			"reference": "32323",
			"nominalCode": "0010",
			"currencyId": 1,
			"poRowQty": 100,
			"exchangeRate": 1,
			"payableSupplierId": 293,
			"isReconciled": true
		}
	]
}

Example 3

Invalid query parameter example.

Request URI

/landed-cost?orderId=999999999999

Response

{
	"response": [
		{
			"code": "INVALID_ORDER_ID",
			"message": "orderId must be less than 2147483648"
		}
	]
}